<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>To Do List</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="bkn.bibtex-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Indices&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/bibkn/">bkn.bibtex</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">&nbsp;</td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="todo-index.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<center><b>[
 <a href="identifier-index.html">Identifiers</a>
| <a href="todo-index.html">To Do</a>
| <a href="deprecated-index.html">Deprecations</a>
]</b></center><br />
<h1 class="epydoc"><a name="todo">To Do List</a></h1>
<br />
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography-module.html">bkn.bibtex.bibliography</a></b>    <ul class="nomargin">
      <li>write module level documentation</li>
      <li>test all file and string input with a variety of string encodings.</li>
    </ul>
</table></div>
<div class="private">
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography.Bibliography-class.html#_load_from_BibJSON_file" onclick="show_private();">bkn.bibtex.bibliography.Bibliography._load_from_BibJSON_file</a></b>    <ul class="nomargin">
      <li>the encoding keyword is not currently handled correctly if 
    <code>file</code> is a <code>File</code> object (as opposed to a file 
    name). It may be best to split these two approaches into distinct 
    methods.</li>
    </ul>
</table></div>
<div class="private">
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography.Bibliography-class.html#_load_from_BibJSON_string" onclick="show_private();">bkn.bibtex.bibliography.Bibliography._load_from_BibJSON_string</a></b>    <ul class="nomargin">
      <li>add support for linkage?</li>
      <li>add support for schema?</li>
    </ul>
</table></div>
<div class="private">
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography.Bibliography-class.html#_load_from_bibtex_file" onclick="show_private();">bkn.bibtex.bibliography.Bibliography._load_from_bibtex_file</a></b>    <ul class="nomargin">
      <li>the encoding keyword is not currently handled correctly if 
    <code>file</code> is a <code>File</code> object (as opposed to a file 
    name). It may be best to split these two approaches into distinct 
    methods.</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography.Bibliography-class.html#add_bibtex_output">bkn.bibtex.bibliography.Bibliography.add_bibtex_output</a></b>    <ul class="nomargin">
      <li>this method should only attempt to create bibtex output for those 
    records which represent bibliographic items. (Records for authors, 
    institutions, and the like should be ignored.)</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography.Bibliography-class.html#get_unique_id">bkn.bibtex.bibliography.Bibliography.get_unique_id</a></b>    <ul class="nomargin">
      <li>update tests for this method (the prefix keyword is new)</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography.Bibliography-class.html#load_from_file">bkn.bibtex.bibliography.Bibliography.load_from_file</a></b>    <ul class="nomargin">
      <li>consider revising this API. It may be better to do away with the format
    keyword and to use separate methods instead. Another possibility would 
    be to make this and similar methods class methods which return a 
    Bibliography object.</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography.Bibliography-class.html#load_from_string">bkn.bibtex.bibliography.Bibliography.load_from_string</a></b>    <ul class="nomargin">
      <li>consider revising this API. It may be better to do away with the format
    keyword and to use separate methods instead.</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography.Bibliography-class.html#to_bibtex">bkn.bibtex.bibliography.Bibliography.to_bibtex</a></b>    <ul class="nomargin">
      <li>write tests for this method.</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography.Bibliography-class.html#validate_record">bkn.bibtex.bibliography.Bibliography.validate_record</a></b>    <ul class="nomargin">
      <li>should check against this bibliography's schema</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography.Record-class.html#__init__">bkn.bibtex.bibliography.Record.__init__</a></b>    <ul class="nomargin">
      <li>deprecate 'citekey' and 'bibtype' keyword arguments in favor of 'id' 
    and 'type'</li>
      <li>consider subclassing BKNBibtexError</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography.Record-class.html#__setitem__">bkn.bibtex.bibliography.Record.__setitem__</a></b>    <ul class="nomargin">
      <li>use schema to check object attribute_value for allowed values.</li>
      <li>this method is long and confusing. it should be refactored.</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography.Record-class.html#validate">bkn.bibtex.bibliography.Record.validate</a></b>    <ul class="nomargin">
      <li>add fuctionality.</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography-module.html#bibliography_from_id">bkn.bibtex.bibliography.bibliography_from_id</a></b>    <ul class="nomargin">
      <li>consider revising or replacing the caching system used here.</li>
      <li>add error handling</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.bibliography-module.html#record_from_id">bkn.bibtex.bibliography.record_from_id</a></b>    <ul class="nomargin">
      <li>document return values and exceptions</li>
      <li>use appropriate error classes</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.comparisons-module.html#compare_name_strings">bkn.bibtex.comparisons.compare_name_strings</a></b>    <ul class="nomargin">
      <li>This or a similar method should take either a list of strings or a list
    of Name objects.</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.comparisons-module.html#compare_names">bkn.bibtex.comparisons.compare_names</a></b>    <ul class="nomargin">
      <li>create a Name object and modify this method to work with Name objects 
    as well as strings.</li>
      <li>add error handling in case invalid arguments are passed</li>
      <li>document method of comparison</li>
      <li>This method is long! Consider refactoring!</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.latex_converter.latex_converter.LatexConverter-class.html">bkn.bibtex.latex_converter.latex_converter.LatexConverter</a></b>    <ul class="nomargin">
      <li>improve documentation</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.latex_converter.latex_converter.LatexConverter-class.html#convert">bkn.bibtex.latex_converter.latex_converter.LatexConverter.convert</a></b>    <ul class="nomargin">
      <li>use properly subclassed exceptions</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.latex_converter.latex_converter.LatexConverter-class.html#extend_vocabulary">bkn.bibtex.latex_converter.latex_converter.LatexConverter.extend_vocabulary</a></b>    <ul class="nomargin">
      <li>raise appropriate error if callback name has already been used</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.new_merge_tools-module.html#merge_bibs">bkn.bibtex.new_merge_tools.merge_bibs</a></b>    <ul class="nomargin">
      <li>This method needs to be revised so as to assign ids in a consistent 
    manner, i.e. the same id should be assigned to the same record on 
    multiple passes.</li>
      <li>This method currently fails since it may create a bib with duplicate 
    ids during intermediate stages. This must be fixed.</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.new_merge_tools-module.html#simple_confirmation_ui">bkn.bibtex.new_merge_tools.simple_confirmation_ui</a></b>    <ul class="nomargin">
      <li>consider extracting this behavior into a new ConfirmationUI class.</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.string_tools-module.html">bkn.bibtex.string_tools</a></b>    <ul class="nomargin">
      <li>add module level documentation.</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.string_tools-module.html#tex2ascii">bkn.bibtex.string_tools.tex2ascii</a></b>    <ul class="nomargin">
      <li>add real world examples to the documentation for this method</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.string_tools-module.html#tex2html">bkn.bibtex.string_tools.tex2html</a></b>    <ul class="nomargin">
      <li>add real world examples to the documentation for this method</li>
    </ul>
</table></div>
<div>
<table width="100%" class="metadata-index" bgcolor="#e0e0e0"><tr><td class="metadata-index"><b>To Do in <a href="bkn.bibtex.string_tools-module.html#tex2unicode">bkn.bibtex.string_tools.tex2unicode</a></b>    <ul class="nomargin">
      <li>add real world examples to the documentation for this method</li>
    </ul>
</table></div>
<br /><!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="bkn.bibtex-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Indices&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/bibkn/">bkn.bibtex</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Jul  4 23:10:58 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
